# eric7.Plugins.PluginVcsSubversion

Module implementing the Subversion version control plugin.

### Global Attributes

__header__
error
subversionCfgPluginObject

### Classes

VcsSubversionPlugin | Class implementing the Subversion version control plugin.

### Functions

createConfigurationPage | Module function to create the configuration page.
displayString | Public function to get the display string.
exeDisplayData | Public method to support the display of some executable info.
getConfigData | Module function returning data as required by the configuration dialog.
getVcsSystemIndicator | Public function to get the indicators for this version control system.
prepareUninstall | Module function to prepare for an uninstallation.

## VcsSubversionPlugin

Class implementing the Subversion version control plugin.

### Derived from

QObject

### Class Attributes

None

### Class Methods

None

### Methods

VcsSubversionPlugin | Constructor
activate | Public method to activate this plugin.
deactivate | Public method to deactivate this plugin.
getConfigPath | Public method to get the filename of the config file.
getPreferences | Public method to retrieve the various settings.
getProjectHelper | Public method to get a reference to the project helper object.
getServersPath | Public method to get the filename of the servers file.
initToolbar | Public slot to initialize the VCS toolbar.
prepareUninstall | Public method to prepare for an uninstallation.
prepareUnload | Public method to prepare for an unload.
setPreferences | Public method to store the various settings.

### Static Methods

None

#### VcsSubversionPlugin (Constructor)

VcsSubversionPlugin(ui)

Constructor

ui (UserInterface)
  reference to the user interface object

#### VcsSubversionPlugin.activate

activate()

Public method to activate this plugin.

Return:
  tuple of reference to instantiated viewmanager and activation status

Return Type:
  tuple of (Subversion, bool)

#### VcsSubversionPlugin.deactivate

deactivate()

Public method to deactivate this plugin.

#### VcsSubversionPlugin.getConfigPath

getConfigPath()

Public method to get the filename of the config file.

Return:
  filename of the config file

Return Type:
  str

#### VcsSubversionPlugin.getPreferences

getPreferences(key)

Public method to retrieve the various settings.

key (str)
  the key of the value to get

Return:
  the requested setting

Return Type:
  Any

#### VcsSubversionPlugin.getProjectHelper

getProjectHelper()

Public method to get a reference to the project helper object.

Return:
  reference to the project helper object

Return Type:
  SvnProjectHelper

#### VcsSubversionPlugin.getServersPath

getServersPath()

Public method to get the filename of the servers file.

Return:
  filename of the servers file

Return Type:
  str

#### VcsSubversionPlugin.initToolbar

initToolbar(ui, toolbarManager)

Public slot to initialize the VCS toolbar.

ui (UserInterface)
  reference to the main window
toolbarManager (EricToolBarManager)
  reference to a toolbar manager object

#### VcsSubversionPlugin.prepareUninstall

prepareUninstall()

Public method to prepare for an uninstallation.

#### VcsSubversionPlugin.prepareUnload

prepareUnload()

Public method to prepare for an unload.

#### VcsSubversionPlugin.setPreferences

setPreferences(key, value)

Public method to store the various settings.

key (str)
  the key of the setting to be set
value (Any)
  the value to be set

Up

## createConfigurationPage

createConfigurationPage(_configDlg)

Module function to create the configuration page.

_configDlg (QDialog)
  reference to the configuration dialog (unused)

Return:
  reference to the configuration page

Return Type:
  SubversionPage

Up

## displayString

displayString()

Public function to get the display string.

Return:
  display string

Return Type:
  str

Up

## exeDisplayData

exeDisplayData()

Public method to support the display of some executable info.

Return:
  dictionary containing the data to query the presence of the executable

Return Type:
  dict

Up

## getConfigData

getConfigData()

Module function returning data as required by the configuration dialog.

Return:
  dictionary with key "zzz_subversionPage" containing the relevant

Return Type:
  dict data

Up

## getVcsSystemIndicator

getVcsSystemIndicator()

Public function to get the indicators for this version control system.

Return:
  dictionary with indicator as key and a tuple with the vcs name and vcs display string

Return Type:
  dict

Up

## prepareUninstall

prepareUninstall()

Module function to prepare for an uninstallation.

Up